home *** CD-ROM | disk | FTP | other *** search
/ Sunday Savers: Sharing Fun! I Know My Savior Lives / Sunday Savers: Sharing Fun! I Know My Savior Lives.iso / mac / Xtras / Buddy API 1.6 / Buddy API Docs.swf / texts / 1528.txt < prev    next >
Encoding:
Text File  |  2004-08-31  |  3.7 KB  |  157 lines
  1. 126
  2. --- RECORDSEPARATOR ---
  3.  
  4. --- RECORDSEPARATOR ---
  5. CopyFile 
  6. --- RECORDSEPARATOR ---
  7. Platform:
  8. --- RECORDSEPARATOR ---
  9.  
  10. --- RECORDSEPARATOR ---
  11. Windows and Macintosh
  12. --- RECORDSEPARATOR ---
  13.  
  14. --- RECORDSEPARATOR ---
  15. Description:
  16. --- RECORDSEPARATOR ---
  17.  
  18. --- RECORDSEPARATOR ---
  19. baCopyFile copies a file.
  20. --- RECORDSEPARATOR ---
  21.  
  22. --- RECORDSEPARATOR ---
  23. Usage:
  24. --- RECORDSEPARATOR ---
  25.  
  26. --- RECORDSEPARATOR ---
  27. Result = baCopyFile( SourceFile , DestFile , Overwrite )
  28. --- RECORDSEPARATOR ---
  29.  
  30. --- RECORDSEPARATOR ---
  31. Arguments:
  32. --- RECORDSEPARATOR ---
  33.  
  34. --- RECORDSEPARATOR ---
  35. String, String, String. 
  36. --- RECORDSEPARATOR ---
  37. SourceFile is the file to copy. 
  38. --- RECORDSEPARATOR ---
  39. DestFile is the name to copy it to. 
  40. --- RECORDSEPARATOR ---
  41. Overwrite determines how the copy is done. Can be: 
  42. --- RECORDSEPARATOR ---
  43. "Always" 
  44. --- RECORDSEPARATOR ---
  45. always copies the file 
  46. --- RECORDSEPARATOR ---
  47. "IfNewer" 
  48. --- RECORDSEPARATOR ---
  49. copies the file if SourceFile is newer than DestFile 
  50. --- RECORDSEPARATOR ---
  51. "IfNotExist" 
  52. --- RECORDSEPARATOR ---
  53. copies only if DestFile does not already exist
  54. --- RECORDSEPARATOR ---
  55.  
  56. --- RECORDSEPARATOR ---
  57. Returns:
  58. --- RECORDSEPARATOR ---
  59.  
  60. --- RECORDSEPARATOR ---
  61. Integer. 
  62. --- RECORDSEPARATOR ---
  63. Returns 0 if the file was copied successfully, otherwise one of these: 
  64. --- RECORDSEPARATOR ---
  65. 1 
  66. --- RECORDSEPARATOR ---
  67. Invalid Source file name 
  68. --- RECORDSEPARATOR ---
  69. 2 
  70. --- RECORDSEPARATOR ---
  71. Invalid Dest file name 
  72. --- RECORDSEPARATOR ---
  73. 3 
  74. --- RECORDSEPARATOR ---
  75. Error reading the Source file 
  76. --- RECORDSEPARATOR ---
  77. 4 
  78. --- RECORDSEPARATOR ---
  79. Error writing the Dest file 
  80. --- RECORDSEPARATOR ---
  81. 5 
  82. --- RECORDSEPARATOR ---
  83. Couldn't create directory for Dest file 
  84. --- RECORDSEPARATOR ---
  85. 6 
  86. --- RECORDSEPARATOR ---
  87. Dest file exists 
  88. --- RECORDSEPARATOR ---
  89. 7 
  90. --- RECORDSEPARATOR ---
  91. Dest file is newer that Source f
  92. --- RECORDSEPARATOR ---
  93. ile
  94. --- RECORDSEPARATOR ---
  95.  
  96. --- RECORDSEPARATOR ---
  97. Examples:
  98. --- RECORDSEPARATOR ---
  99.  
  100. --- RECORDSEPARATOR ---
  101. Director: 
  102. --- RECORDSEPARATOR ---
  103. set OK = baCopyFile("c:\data\student.dat", "c:\data\backup\student.dat", "IfNewer") 
  104. --- RECORDSEPARATOR ---
  105. Authorware: 
  106. --- RECORDSEPARATOR ---
  107. OK := baCopyFile("c:\\data\\student.dat", "c:\\data\\backup\\student.dat", "IfNewer")
  108. --- RECORDSEPARATOR ---
  109.  
  110. --- RECORDSEPARATOR ---
  111. Notes:
  112. --- RECORDSEPARATOR ---
  113.  
  114. --- RECORDSEPARATOR ---
  115. By default, this function will not overwrite an existing file if that file is marked as 
  116. --- RECORDSEPARATOR ---
  117. read-only. However, by adding "+"  to the "Always" and "IfNewer" options ( eg 
  118. --- RECORDSEPARATOR ---
  119. "Always+" or "IfNewer+"), the files will be overwritten if they are read-only. 
  120. --- RECORDSEPARATOR ---
  121. A return value of 6 (Dest file exists) can only be returned when Overwrite is 
  122. --- RECORDSEPARATOR ---
  123. "IfNotExist". 
  124. --- RECORDSEPARATOR ---
  125. A return value of 7 (Dest file is newer than Source file) can only be returned when 
  126. --- RECORDSEPARATOR ---
  127. Overwrite is "IfNewer". The other return values can be returned for all Overwrite 
  128. --- RECORDSEPARATOR ---
  129. options. 
  130. --- RECORDSEPARATOR ---
  131. The "IfNewer" option operates as follows on
  132. --- RECORDSEPARATOR ---
  133.  Windows
  134. --- RECORDSEPARATOR ---
  135. : if both files have internal 
  136. --- RECORDSEPARATOR ---
  137. version numbers, then these numbers are used for comparison, otherwise the 
  138. --- RECORDSEPARATOR ---
  139. dates of the two files are used for comparison. On
  140. --- RECORDSEPARATOR ---
  141.  Macintosh
  142. --- RECORDSEPARATOR ---
  143. , only the file dates 
  144. --- RECORDSEPARATOR ---
  145. are used for comparison. 
  146. --- RECORDSEPARATOR ---
  147. The DestFile must contain the full name of the file, not just the name of the folder it 
  148. --- RECORDSEPARATOR ---
  149. is being copied to.
  150. --- RECORDSEPARATOR ---
  151.  
  152. --- RECORDSEPARATOR ---
  153. See also:
  154. --- RECORDSEPARATOR ---
  155.  
  156. --- RECORDSEPARATOR ---
  157. baCopyXFiles